docs(isthmus): javadoc for io.substrait.isthmus type system classes#762
Merged
bestbeforetoday merged 2 commits intosubstrait-io:mainfrom Mar 25, 2026
Merged
docs(isthmus): javadoc for io.substrait.isthmus type system classes#762bestbeforetoday merged 2 commits intosubstrait-io:mainfrom
bestbeforetoday merged 2 commits intosubstrait-io:mainfrom
Conversation
mbwhite
changed the title
bestbeforetoday
requested changes
Mar 25, 2026
Member
bestbeforetoday
left a comment
bestbeforetoday
left a comment
There was a problem hiding this comment.
Generally good. Just a couple of errors mentioned in comments.
Comment on lines
+60
to
+64
| /** | ||
| * Returns the maximum numeric scale supported by this type system. | ||
| * | ||
| * @return Maximum numeric scale (38). | ||
| */ |
Member
There was a problem hiding this comment.
This description is incorrect. The parent interface Javadoc says:
/**
* Returns default precision for this type if supported, otherwise
* {@link RelDataType#PRECISION_NOT_SPECIFIED}
* if precision is either unsupported or must be specified explicitly.
*
* @return Default precision
*/Also, the return value (in the current implementation) is 38 for the decimal type, but not for any other type.
Comment on lines
+75
to
+79
| /** | ||
| * Returns the maximum numeric precision supported by this type system. | ||
| * | ||
| * @return Maximum numeric precision (38). | ||
| */ |
Member
There was a problem hiding this comment.
This description is incorrect. The parent interface Javadoc says:
/**
* Returns the maximum scale allowed for this type, or
* {@link RelDataType#SCALE_NOT_SPECIFIED}
* if scale is not applicable for this type.
*
* @return Maximum allowed scale
*/The maximum scale for the decimal type (in the current implementation) is 38. For all other types it is different.
|
|
||
| private final UserTypeMapper userTypeMapper; | ||
|
|
||
| // DEFAULT TypeConverter which does not handle user-defined types |
Member
There was a problem hiding this comment.
The Javadoc below now provides the same information so this line can be removed.
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
mbwhite
force-pushed
the
fix-javadoc-c-008
branch
from
d8c7b10 to
b59a7df
Compare
bestbeforetoday
approved these changes
Mar 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.